<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BrokenIRC: bonus/RFC2812Markdown.md Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">BrokenIRC
   &#160;<span id="projectnumber">0.0.42</span>
   </div>
   <div id="projectbrief">A &#39;not so functionnal&#39; irc server and a WIP client</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">bonus/RFC2812Markdown.md</div>  </div>
</div><!--header-->
<div class="contents">
<a href="RFC2812Markdown_8md.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;# BrokenIRC rev 0.43 RFC Write Up</div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;</div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;## Current version [#QuickAndDirty](https://github.com/trevisg/PSU_myirc_2017BrokenStuffisBack/releases/tag/vQuickAndDirty)</div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;This is (supposed to be) an EPITECH BrokenIRC Protocol RFC&#39;s [2812](https://tools.ietf.org/html/rfc2812) &amp; oldest [1459](https://tools.ietf.org/html/rfc1459)</div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;compliant IRCd C server</div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;##### From Subject :</div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;&gt; You **MUST** not use thread(), fork() &amp; fcntl() kind off functions</div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;&gt; =&gt;&gt; Tss easy [epoll control](man7.org/linux/man-pages/man2/epoll_ctl.2.html) ..</div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;### 1. IRC commands from client to server:</div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;| CMD      | USAGE                         | Description                   |</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;|-------|:-----------------------------:|------------------------------:|</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;| USER     | `USER &lt;SP&gt; &lt;username&gt; &lt;CRLF&gt;` | Specify user for authentication |</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;### 2. Command-Reply Sequences (Mandatory part)</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;&gt;The server reply is defined to contain the 3-digit code, followed by space</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;&gt; **&lt; SP &gt;** , followed by one line of text, and terminated by the Irc end-of-line code **&lt; CRLF &gt;** (aka ```\r\n```).</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;### 3. Example :</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;```</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;-&gt; NICK &lt;SP&gt; Nickname &lt;CRLF&gt;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;-&gt; USER &lt;SP&gt; Username &lt;CRLF&gt;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;&lt;- 331 &lt;SP&gt; User name okay, need password. &lt;CRLF&gt;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;-&gt; PASS &lt;SP&gt; Password &lt;CRLF&gt;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;&lt;- 230 &lt;SP&gt; User logged in, proceed. &lt;CRLF&gt;</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;```</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;&gt; **-&gt;** : Request command from client to server</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;&gt; **&lt;-** : Reply from server to client</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;            Connection Establishment</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;            Registration</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;               USER -&gt;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;                  &lt;- 230</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;                  &lt;- xxx</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;                  &lt;- 331</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;               PASS -&gt;</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;                  &lt;- 230</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;                  &lt;- 332</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;                  &lt;- xxx</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;               CWD -&gt;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;                  &lt;- 250</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;                  &lt;- xxx</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;               CDUP -&gt;</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;                  &lt;- 200</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;                  &lt;- xxx</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;            Logout</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;               QUIT -&gt;</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;                  &lt;- 221</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;                  &lt;- xxx</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;### 5. Numeric  Order List of Mandatory Reply Codes (Extract)</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;| Code       | Description                                                 |</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;|:-------:|:-----------------------------------------------------------:|</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;|   001   | The very first response from server                            |</div></div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
